docs(lark-wiki): tighten SKILL.md per skill review#1275
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughRefines the lark-wiki skill docs: clarifies routing for doubao.com/wiki tokens, adds BAD/GOOD delete-space workflow, reorganizes member-add steps with ID lookup, requires ChangesWiki Skill Documentation Refinement
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1275 +/- ##
==========================================
+ Coverage 70.18% 70.33% +0.14%
==========================================
Files 671 672 +1
Lines 65240 65322 +82
==========================================
+ Hits 45786 45941 +155
+ Misses 15783 15728 -55
+ Partials 3671 3653 -18 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@923dc9f88e000b8c908e4c37081106fa4a8862c0🧩 Skill updatenpx skills add larksuite/cli#docs/optimize-lark-wiki-skill -y -g |
5010a3e to
042c09c
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-wiki/SKILL.md`:
- Around line 79-80: Replace the incorrect Chinese collocation "部门场景" in the two
bullet points with a better phrase such as "部门相关场景" or "涉及部门时"; update both
occurrences in SKILL.md (the two lines that mention calling the contact API and
then `lark-cli wiki +member-add`) so the text reads e.g. "部门相关场景使用
`--member-type=opendepartmentid`:..." and "只有在目标类型和身份都已确认可行后,才调用 `lark-cli wiki
+member-add`。对于部门相关场景,这意味着必须是 `--as user`。" Ensure consistency for both
instances.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
042c09c to
c2bb954
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
skills/lark-wiki/SKILL.md (1)
79-80:⚠️ Potential issue | 🟡 Minor | ⚡ Quick win建议替换“部门场景”为更自然表达(如“涉及部门时/部门相关场景”)。
这两处搭配不够自然,建议统一替换,避免文档读感割裂。
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-wiki/SKILL.md` around lines 79 - 80, Replace the wording "部门场景" with a more natural phrase (e.g., "涉及部门时" or "部门相关场景") in the two occurrences shown around the examples: the line containing "`--member-type=opendepartmentid`" (the CLI call that fetches `open_department_id`) and the line referencing "`lark-cli wiki +member-add`" (the note about needing `--as user` for department cases); keep the surrounding CLI examples and meaning unchanged, only update the phrase for consistent, natural prose.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@skills/lark-wiki/SKILL.md`:
- Around line 79-80: Replace the wording "部门场景" with a more natural phrase
(e.g., "涉及部门时" or "部门相关场景") in the two occurrences shown around the examples:
the line containing "`--member-type=opendepartmentid`" (the CLI call that
fetches `open_department_id`) and the line referencing "`lark-cli wiki
+member-add`" (the note about needing `--as user` for department cases); keep
the surrounding CLI examples and meaning unchanged, only update the phrase for
consistent, natural prose.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 2af759cc-3273-42aa-bf08-ca07720603ec
📒 Files selected for processing (2)
skill-template/domains/wiki.mdskills/lark-wiki/SKILL.md
✅ Files skipped from review due to trivial changes (1)
- skill-template/domains/wiki.md
76c9f14 to
2e4c765
Compare
- Add explicit NOT boundaries to the description and a dedicated "不在本 skill 范围" section: file upload -> lark-drive, content editing -> lark-doc / lark-sheets / lark-base. - Move the Shortcuts table up, right after 快速决策, so command entry points are discoverable first; keep the member-add flow and target-semantics sections after it. - Add an inline reminder under the delete-space guidance that a wiki URL / name is not a space_id and must be resolved via `wiki spaces get_node` first. - Remove the duplicated permission (scope) table and the redundant schema note so auth/permission guidance stays centralized in lark-shared. - Bump the skill version to 1.0.1. - Keep skill-template/domains/wiki.md in sync with the SKILL.md introduction narrative. Change-Id: If2b4341f350191ee0a65bf3a2cab9afa2b76d931
2e4c765 to
923dc9f
Compare
Summary
Optimize the
lark-wikiskill for clearer routing boundaries, better shortcut discoverability, and less duplicated maintenance-heavy guidance. Documentation only — no code or CLI behavior changes.## 不在本 skill 范围section: file upload →lark-drive, content editing →lark-doc/lark-sheets/lark-base, search / comments / permissions →lark-drive.快速决策) so command entry points are discoverable first; keep the member-add flow and target-semantics sections after it.space_idand must be resolved viawiki spaces get_nodefirst.lark-shared(the API resource listing is kept).skill-template/domains/wiki.mdin sync with the SKILL.md introduction narrative.Testing
node scripts/skill-format-check/index.js skills→ passed快速决策sections inSKILL.mdanddomains/wiki.mdverified identicalNote
Supersedes #1280 (same target file). This PR additionally keeps the API Resources resource listing and syncs the domain template.